home *** CD-ROM | disk | FTP | other *** search
/ Stone Design / Stone Design.iso / Stone_Friends / Wave / WavesWorld / Source / Libraries / tcl7.4b3 / doc / lindex.n < prev    next >
Encoding:
Text File  |  1995-01-30  |  1.1 KB  |  38 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" Copyright (c) 1994-1995 Sun Microsystems, Inc.
  4. '\"
  5. '\" See the file "license.terms" for information on usage and redistribution
  6. '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '\" 
  8. '\" @(#) lindex.n 1.4 95/01/30 10:32:28
  9. '\" 
  10. .so man.macros
  11. .HS lindex tcl 7.4
  12. .BS
  13. '\" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. lindex \- Retrieve an element from a list
  16. .SH SYNOPSIS
  17. \fBlindex \fIlist index\fR
  18. .BE
  19.  
  20. .SH DESCRIPTION
  21. .PP
  22. This command treats \fIlist\fR as a Tcl list and returns the
  23. \fIindex\fR'th element from it (0 refers to the first element of the list).
  24. In extracting the element, \fIlindex\fR observes the same rules
  25. concerning braces and quotes and backslashes as the Tcl command
  26. interpreter; however, variable
  27. substitution and command substitution do not occur.
  28. If \fIindex\fR is negative or greater than or equal to the number
  29. of elements in \fIvalue\fR, then an empty
  30. string is returned.
  31. .VS
  32. If \fIindex\fR has the value \fBend\fR, it refers to the last element
  33. in the list.
  34. .VE
  35.  
  36. .SH KEYWORDS
  37. element, index, list
  38.